<!-- HTML header for doxygen 1.9.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<title>libsir: The Standard Incident Reporter Library</title>
<!-- OpenGraph -->
<meta property="og:title" content="libsir: The Standard Incident Reporter Library">
<meta property="og:description" content="A lightweight, cross-platform C library for information distribution">
<meta property="og:url" content="https://libsir.rml.dev">
<meta property="og:type" content="website">
<meta property="og:image" content="https://libsir.rml.dev/res/libsir-og.png">
<meta name="twitter:card" content="summary_large_image"></meta>
<meta name="twitter:title" content="libsir: The Standard Incident Reporter Library"></meta>
<meta name="twitter:description" content="A lightweight, cross-platform C library for information distribution"></meta>
<meta name="twitter:image" content="https://libsir.rml.dev/res/libsir-og.png"></meta>
<!-- /OpenGraph -->
<!-- favicon -->
<link rel="icon" href="res/libsir-icon.png">
<link rel="icon" href="res/libsir-icon.svg" type="image/svg+xml">
<link rel="manifest" href="res/icons.webmanifest">
<!-- /favicon -->
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<link href="rml-navtree.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.6</span>
   </div>
   <div id="projectbrief">Standard Incident Reporter</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('sir_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">sir.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Public interface to libsir.  
<a href="#details">More...</a></p>
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="sir_8h__dep__incl.svg" width="523" height="182"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="sir_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac21fb86ac7e7710400bf8b642887ad96" id="r_gac21fb86ac7e7710400bf8b642887ad96"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gac21fb86ac7e7710400bf8b642887ad96">sir_makeinit</a> (<a class="el" href="group__publictypes.html#structsirinit">sirinit</a> *si)</td></tr>
<tr class="memdesc:gac21fb86ac7e7710400bf8b642887ad96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills out a <a class="el" href="group__publictypes.html#structsirinit" title="libsir initialization and configuration data.">sirinit</a> structure with default values.  <br /></td></tr>
<tr class="separator:gac21fb86ac7e7710400bf8b642887ad96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4f5707f5e4ed9702cde75a8c80c4e4a" id="r_gaa4f5707f5e4ed9702cde75a8c80c4e4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaa4f5707f5e4ed9702cde75a8c80c4e4a">sir_init</a> (<a class="el" href="group__publictypes.html#structsirinit">sirinit</a> *si)</td></tr>
<tr class="memdesc:gaa4f5707f5e4ed9702cde75a8c80c4e4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes libsir for use.  <br /></td></tr>
<tr class="separator:gaa4f5707f5e4ed9702cde75a8c80c4e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bf3e92cefac01de4e3c6c359a58706f" id="r_ga9bf3e92cefac01de4e3c6c359a58706f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga9bf3e92cefac01de4e3c6c359a58706f">sir_cleanup</a> (void)</td></tr>
<tr class="memdesc:ga9bf3e92cefac01de4e3c6c359a58706f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tears down and cleans up libsir after use.  <br /></td></tr>
<tr class="separator:ga9bf3e92cefac01de4e3c6c359a58706f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4cfb0e00a47760eb1778d78dd84b290" id="r_gac4cfb0e00a47760eb1778d78dd84b290"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gac4cfb0e00a47760eb1778d78dd84b290">sir_isinitialized</a> (void)</td></tr>
<tr class="memdesc:gac4cfb0e00a47760eb1778d78dd84b290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether or not libsir is in the initialized state.  <br /></td></tr>
<tr class="separator:gac4cfb0e00a47760eb1778d78dd84b290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0c399c73c25d1128befc6b75cbae300" id="r_gac0c399c73c25d1128befc6b75cbae300"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gac0c399c73c25d1128befc6b75cbae300">sir_geterror</a> (char message[<a class="el" href="config_8h.html#ad6fce840144259e992c33fb611f31262">SIR_MAXERROR</a>])</td></tr>
<tr class="memdesc:gac0c399c73c25d1128befc6b75cbae300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.  <br /></td></tr>
<tr class="separator:gac0c399c73c25d1128befc6b75cbae300"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaedefdc4fb0546a210740ad0fb87f7b34" id="r_gaedefdc4fb0546a210740ad0fb87f7b34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaedefdc4fb0546a210740ad0fb87f7b34">sir_geterrorinfo</a> (<a class="el" href="group__publictypes.html#structsir__errorinfo">sir_errorinfo</a> *err)</td></tr>
<tr class="memdesc:gaedefdc4fb0546a210740ad0fb87f7b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves granular information about the last error that occurred on the calling thread.  <br /></td></tr>
<tr class="separator:gaedefdc4fb0546a210740ad0fb87f7b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e2563198d16d5c7ba7bdf55fec9215c" id="r_ga7e2563198d16d5c7ba7bdf55fec9215c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga7e2563198d16d5c7ba7bdf55fec9215c">sir_debug</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:ga7e2563198d16d5c7ba7bdf55fec9215c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#gaa2927c260f1d8fac96513442e50105fc" title="Debugging/diagnostic output.">SIRL_DEBUG</a> level message.  <br /></td></tr>
<tr class="separator:ga7e2563198d16d5c7ba7bdf55fec9215c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9aa2c092ae4ff0bf75043dce10166661" id="r_ga9aa2c092ae4ff0bf75043dce10166661"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga9aa2c092ae4ff0bf75043dce10166661">sir_info</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:ga9aa2c092ae4ff0bf75043dce10166661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#ga9e73defcee82050f038956ad7e911621" title="Informational messages.">SIRL_INFO</a> level message.  <br /></td></tr>
<tr class="separator:ga9aa2c092ae4ff0bf75043dce10166661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b8cad62f929e549f2d031470e3a1fc7" id="r_ga3b8cad62f929e549f2d031470e3a1fc7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga3b8cad62f929e549f2d031470e3a1fc7">sir_notice</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:ga3b8cad62f929e549f2d031470e3a1fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#gad4aefd62d77b020460d32c9350bec7d5" title="Normal but significant.">SIRL_NOTICE</a> level message.  <br /></td></tr>
<tr class="separator:ga3b8cad62f929e549f2d031470e3a1fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf71ddaf533f10cf278986d4bdb3f76f" id="r_gabf71ddaf533f10cf278986d4bdb3f76f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gabf71ddaf533f10cf278986d4bdb3f76f">sir_warn</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:gabf71ddaf533f10cf278986d4bdb3f76f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#ga91b18adc2526599377583951c29e84b9" title="Warnings that could likely be ignored.">SIRL_WARN</a> level message.  <br /></td></tr>
<tr class="separator:gabf71ddaf533f10cf278986d4bdb3f76f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3955274b94bf3d09ad8ebefd93035aa3" id="r_ga3955274b94bf3d09ad8ebefd93035aa3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga3955274b94bf3d09ad8ebefd93035aa3">sir_error</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:ga3955274b94bf3d09ad8ebefd93035aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#ga39dffb8c9c5100251098820cb5b48446" title="Errors.">SIRL_ERROR</a> level message.  <br /></td></tr>
<tr class="separator:ga3955274b94bf3d09ad8ebefd93035aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4836aea12ba1a2b187f325a416ea9c2" id="r_gab4836aea12ba1a2b187f325a416ea9c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gab4836aea12ba1a2b187f325a416ea9c2">sir_crit</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:gab4836aea12ba1a2b187f325a416ea9c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#gac559a9050c927bf0dc9f88dfc3905e06" title="Critical errors.">SIRL_CRIT</a> level message.  <br /></td></tr>
<tr class="separator:gab4836aea12ba1a2b187f325a416ea9c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga235d760d94e67fcf82ccc16c77a8249e" id="r_ga235d760d94e67fcf82ccc16c77a8249e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga235d760d94e67fcf82ccc16c77a8249e">sir_alert</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:ga235d760d94e67fcf82ccc16c77a8249e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#ga8549494d396c96ba66b5b78b298cff7d" title="Action required ASAP.">SIRL_ALERT</a> level message.  <br /></td></tr>
<tr class="separator:ga235d760d94e67fcf82ccc16c77a8249e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf94f3dcbd6a14e81f6eca555733dce23" id="r_gaf94f3dcbd6a14e81f6eca555733dce23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaf94f3dcbd6a14e81f6eca555733dce23">sir_emerg</a> (PRINTF_FORMAT const char *format,...)</td></tr>
<tr class="memdesc:gaf94f3dcbd6a14e81f6eca555733dce23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches a <a class="el" href="group__publictypes.html#ga2409f97357f1eb510ababeb6e0a030e8" title="Nuclear war, Armageddon, etc.">SIRL_EMERG</a> level message.  <br /></td></tr>
<tr class="separator:gaf94f3dcbd6a14e81f6eca555733dce23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa04f4ca1fc06e1d99ca4f0fd6422b573" id="r_gaa04f4ca1fc06e1d99ca4f0fd6422b573"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaa04f4ca1fc06e1d99ca4f0fd6422b573">sir_addfile</a> (const char *path, <a class="el" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels, <a class="el" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts)</td></tr>
<tr class="memdesc:gaa04f4ca1fc06e1d99ca4f0fd6422b573"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a log file and registers it to receive log output.  <br /></td></tr>
<tr class="separator:gaa04f4ca1fc06e1d99ca4f0fd6422b573"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba84f2fef8ac18a28483ee02c1c57240" id="r_gaba84f2fef8ac18a28483ee02c1c57240"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaba84f2fef8ac18a28483ee02c1c57240">sir_remfile</a> (<a class="el" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> id)</td></tr>
<tr class="memdesc:gaba84f2fef8ac18a28483ee02c1c57240"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a file previously added to libsir.  <br /></td></tr>
<tr class="separator:gaba84f2fef8ac18a28483ee02c1c57240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a50b52b3ce1af7543b76a219ff01060" id="r_ga1a50b52b3ce1af7543b76a219ff01060"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__publictypes.html#gadbc71df98df765cddfed4aa11c805470">sirpluginid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga1a50b52b3ce1af7543b76a219ff01060">sir_loadplugin</a> (const char *path)</td></tr>
<tr class="memdesc:ga1a50b52b3ce1af7543b76a219ff01060"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a plugin module from disk.  <br /></td></tr>
<tr class="separator:ga1a50b52b3ce1af7543b76a219ff01060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6796c068e61eb505e8dd8e230fbc1423" id="r_ga6796c068e61eb505e8dd8e230fbc1423"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga6796c068e61eb505e8dd8e230fbc1423">sir_unloadplugin</a> (<a class="el" href="group__publictypes.html#gadbc71df98df765cddfed4aa11c805470">sirpluginid</a> id)</td></tr>
<tr class="memdesc:ga6796c068e61eb505e8dd8e230fbc1423"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unloads a previously registered plugin module.  <br /></td></tr>
<tr class="separator:ga6796c068e61eb505e8dd8e230fbc1423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a776d3d55e9f993eb0fad82788e1160" id="r_ga5a776d3d55e9f993eb0fad82788e1160"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga5a776d3d55e9f993eb0fad82788e1160">sir_filelevels</a> (<a class="el" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> id, <a class="el" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels)</td></tr>
<tr class="memdesc:ga5a776d3d55e9f993eb0fad82788e1160"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new level registrations for a log file already managed by libsir.  <br /></td></tr>
<tr class="separator:ga5a776d3d55e9f993eb0fad82788e1160"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf14164a64eca824a2bae72ef4e9689cd" id="r_gaf14164a64eca824a2bae72ef4e9689cd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaf14164a64eca824a2bae72ef4e9689cd">sir_fileopts</a> (<a class="el" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> id, <a class="el" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts)</td></tr>
<tr class="memdesc:gaf14164a64eca824a2bae72ef4e9689cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new formatting options for a log file already managed by libsir.  <br /></td></tr>
<tr class="separator:gaf14164a64eca824a2bae72ef4e9689cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a4726075fbcea9fc311f059e342213f" id="r_ga1a4726075fbcea9fc311f059e342213f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga1a4726075fbcea9fc311f059e342213f">sir_settextstyle</a> (<a class="el" href="group__publictypes.html#ga076e759e9aa36cde2977f754a7ea186c">sir_level</a> level, <a class="el" href="group__publictypes.html#ga1bf5e489a6af0dcb905788c1e7a5ec2d">sir_textattr</a> attr, <a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> fg, <a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> bg)</td></tr>
<tr class="memdesc:ga1a4726075fbcea9fc311f059e342213f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.  <br /></td></tr>
<tr class="separator:ga1a4726075fbcea9fc311f059e342213f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga932eec2f9c73eecdd2b6b935452e5eed" id="r_ga932eec2f9c73eecdd2b6b935452e5eed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga932eec2f9c73eecdd2b6b935452e5eed">sir_resettextstyles</a> (void)</td></tr>
<tr class="memdesc:ga932eec2f9c73eecdd2b6b935452e5eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset text styling for stdio (stdout/stderr) destinations to their default values.  <br /></td></tr>
<tr class="separator:ga932eec2f9c73eecdd2b6b935452e5eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4691e42964819230e1f4b7fdf984ff66" id="r_ga4691e42964819230e1f4b7fdf984ff66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga4691e42964819230e1f4b7fdf984ff66">sir_makergb</a> (<a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> r, <a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> g, <a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> b)</td></tr>
<tr class="memdesc:ga4691e42964819230e1f4b7fdf984ff66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5" title="stdio text color type.">sir_textcolor</a> from red, green, and blue components.  <br /></td></tr>
<tr class="separator:ga4691e42964819230e1f4b7fdf984ff66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31639aba9a825f957a73689ef509f33d" id="r_ga31639aba9a825f957a73689ef509f33d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga31639aba9a825f957a73689ef509f33d">sir_setcolormode</a> (<a class="el" href="group__publictypes.html#ga26686b620930358e8b50f287d6c96e51">sir_colormode</a> mode)</td></tr>
<tr class="memdesc:ga31639aba9a825f957a73689ef509f33d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the ANSI color mode for stdio destinations.  <br /></td></tr>
<tr class="separator:ga31639aba9a825f957a73689ef509f33d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f17febe99cb0beb6f8119283cc62d42" id="r_ga6f17febe99cb0beb6f8119283cc62d42"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga6f17febe99cb0beb6f8119283cc62d42">sir_stdoutlevels</a> (<a class="el" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels)</td></tr>
<tr class="memdesc:ga6f17febe99cb0beb6f8119283cc62d42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new level registrations for <code>stdout</code>.  <br /></td></tr>
<tr class="separator:ga6f17febe99cb0beb6f8119283cc62d42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac117aaf4a045115e58ba4471f9a4747f" id="r_gac117aaf4a045115e58ba4471f9a4747f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gac117aaf4a045115e58ba4471f9a4747f">sir_stdoutopts</a> (<a class="el" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts)</td></tr>
<tr class="memdesc:gac117aaf4a045115e58ba4471f9a4747f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new formatting options for <code>stdout</code>.  <br /></td></tr>
<tr class="separator:gac117aaf4a045115e58ba4471f9a4747f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga421c13f6e269440cef0ac5c1ff3e65dd" id="r_ga421c13f6e269440cef0ac5c1ff3e65dd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga421c13f6e269440cef0ac5c1ff3e65dd">sir_stderrlevels</a> (<a class="el" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels)</td></tr>
<tr class="memdesc:ga421c13f6e269440cef0ac5c1ff3e65dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new level registrations for <code>stderr</code>.  <br /></td></tr>
<tr class="separator:ga421c13f6e269440cef0ac5c1ff3e65dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e78fb3ad87f02ef0f056a34200a4ab9" id="r_ga0e78fb3ad87f02ef0f056a34200a4ab9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga0e78fb3ad87f02ef0f056a34200a4ab9">sir_stderropts</a> (<a class="el" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts)</td></tr>
<tr class="memdesc:ga0e78fb3ad87f02ef0f056a34200a4ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new formatting options for <code>stderr</code>.  <br /></td></tr>
<tr class="separator:ga0e78fb3ad87f02ef0f056a34200a4ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b383287c821bb519868776a4d8bae83" id="r_ga2b383287c821bb519868776a4d8bae83"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga2b383287c821bb519868776a4d8bae83">sir_sysloglevels</a> (<a class="el" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels)</td></tr>
<tr class="memdesc:ga2b383287c821bb519868776a4d8bae83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new level registrations for the system logger destination.  <br /></td></tr>
<tr class="separator:ga2b383287c821bb519868776a4d8bae83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b32a04501257df43bbe56169ab383c2" id="r_ga5b32a04501257df43bbe56169ab383c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga5b32a04501257df43bbe56169ab383c2">sir_syslogopts</a> (<a class="el" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts)</td></tr>
<tr class="memdesc:ga5b32a04501257df43bbe56169ab383c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new formatting options for the system logger destination.  <br /></td></tr>
<tr class="separator:ga5b32a04501257df43bbe56169ab383c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc5831ef9b59c181b6ad7944c2ef1d5f" id="r_gabc5831ef9b59c181b6ad7944c2ef1d5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gabc5831ef9b59c181b6ad7944c2ef1d5f">sir_syslogid</a> (const char *identity)</td></tr>
<tr class="memdesc:gabc5831ef9b59c181b6ad7944c2ef1d5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new system logger identity.  <br /></td></tr>
<tr class="separator:gabc5831ef9b59c181b6ad7944c2ef1d5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac48e99ced63f02c6999f50aca7c56efd" id="r_gac48e99ced63f02c6999f50aca7c56efd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gac48e99ced63f02c6999f50aca7c56efd">sir_syslogcat</a> (const char *category)</td></tr>
<tr class="memdesc:gac48e99ced63f02c6999f50aca7c56efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set new system logger category.  <br /></td></tr>
<tr class="separator:gac48e99ced63f02c6999f50aca7c56efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1e38749df3016bd75c3d7442b708ee9" id="r_gad1e38749df3016bd75c3d7442b708ee9"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gad1e38749df3016bd75c3d7442b708ee9">sir_getversionstring</a> (void)</td></tr>
<tr class="memdesc:gad1e38749df3016bd75c3d7442b708ee9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current libsir version as a string.  <br /></td></tr>
<tr class="separator:gad1e38749df3016bd75c3d7442b708ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga747855ef6deb460266e79629d19451ab" id="r_ga747855ef6deb460266e79629d19451ab"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#ga747855ef6deb460266e79629d19451ab">sir_getversionhex</a> (void)</td></tr>
<tr class="memdesc:ga747855ef6deb460266e79629d19451ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current libsir version as a number.  <br /></td></tr>
<tr class="separator:ga747855ef6deb460266e79629d19451ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7c8bdb30b25e51a494271851677a8d3" id="r_gaf7c8bdb30b25e51a494271851677a8d3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicfuncs.html#gaf7c8bdb30b25e51a494271851677a8d3">sir_isprerelease</a> (void)</td></tr>
<tr class="memdesc:gaf7c8bdb30b25e51a494271851677a8d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not this is a pre-release version of libsir.  <br /></td></tr>
<tr class="separator:gaf7c8bdb30b25e51a494271851677a8d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Public interface to libsir. </p>
<p>The functions and types defined here comprise the entire set intended for use by an implementer of the library-unless modification is desired.</p>
<dl class="section version"><dt>Version</dt><dd>2.2.6</dd></dl>
<hr  />
<p>SPDX-License-Identifier: MIT</p>
<p>Copyright (c) 2018-2024 Ryan M. Lederman <a href="#" onclick="location.href='mai'+'lto:'+'led'+'er'+'man'+'@g'+'mai'+'l.'+'com'; return false;">leder<span class="obfuscator">.nosp@m.</span>man@<span class="obfuscator">.nosp@m.</span>gmail<span class="obfuscator">.nosp@m.</span>.com</a></p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<hr  />
 </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.7-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="sir_8h.html">sir.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
  </ul>
</div>
</body>
</html>
